home *** CD-ROM | disk | FTP | other *** search
/ Whiteline: delta / whiteline CD Series - delta.iso / tools / desktop / minf241 / menuinfo.txt < prev    next >
Text File  |  1995-11-25  |  15KB  |  635 lines
  1.                          The documentation of
  2.  
  3.                                MenuInfo
  4.  
  5.                              Version 2.41
  6.                               11.09.1995
  7.  
  8.                                   by
  9.  
  10.                             Dirk Hagedorn
  11.                            In der Esmecke 9
  12.                            D-59846 Sundern
  13.  
  14.                        dh@mk2.maus.sauerland.de
  15.  
  16.  
  17.  
  18. Contents
  19. ========
  20.  
  21.  1 Introduction
  22.  
  23.  2 Configuration
  24.    2.1 Refresh
  25.    2.2 Redraw
  26.    2.3 Offset
  27.    2.4 Small font
  28.    2.5 Use window
  29.    2.6 CapsLock-LED
  30.    2.7 OFLS-LED
  31.    2.8 Top windows
  32.    2.9 Screensaver
  33.    2.10 Alarm
  34.    2.11 VSCR-support
  35.  
  36.  3 Clicks onto the LEDs
  37.    3.1 Hint for users of TakeOff
  38.  
  39.  4 Placeholders
  40.  
  41.  5 ASCII-table
  42.  
  43.  6 Systemrequirements
  44.  
  45. Appendix
  46. ========
  47.  
  48.  A Legal information
  49.    A.1 Copyright
  50.    A.2 Fairware
  51.    A.3 Disclaimer
  52.    A.4 Trademarks
  53.  
  54.  B Future
  55.  
  56.  C The current version
  57.  
  58.  D Thanks
  59.  
  60.  E History
  61.    E.1 Version 2.41
  62.    E.2 Version 2.40
  63.  
  64.  
  65.  
  66. 1 Introduction
  67. ==============
  68.  
  69. First of all: please excuse my bad english! I did my very best. ;-)
  70.  
  71. MenuInfo is a small utility to show userdefined information in the
  72. unused upper right corner of the screen.
  73.  
  74. MenuInfo offers the following features:
  75.  
  76.    ∙ it runs in application- and accessory mode
  77.  
  78.    ∙ output via AES-objects, so there will be no problems using diffe-
  79.      rent systemfonts
  80.  
  81.    ∙ XSSI-support, so MenuInfo doesn't outputs anything while a
  82.      screensaver is active (e.g. Before Dawn)
  83.  
  84.    ∙ VSCR-support
  85.  
  86.    ∙ VA_START-support
  87.  
  88.    ∙ ST-Guide-support
  89.  
  90.    ∙ an X-Windows-like autotopper for windows
  91.  
  92.    ∙ a little screensaver
  93.  
  94.    ∙ optional output of information in a window
  95.  
  96.    ∙ MenuInfo's information might be copied to the clipboard
  97.  
  98.    ∙ MenuInfo shows the status of CapsLock and OFSL using small LEDs
  99.  
  100.    ∙ online-configuration
  101.  
  102.    ∙ saveable and loadable configuration
  103.  
  104.    ∙ MenuInfo uses only about 45,000 bytes
  105.  
  106.  
  107.  
  108. 2 Configuration
  109. ===============
  110.  
  111. After clicking the left mousebutton while pointing onto the LEDs and
  112. pressing no special keys (Shift, Control, Alternate) or after selec-
  113. ting MenuInfo's menuentry in the deskmenu a formular will be opened.
  114.  
  115. You can see some editfields and lots of buttons.
  116.  
  117. Enter placeholder-combinations into the editfields. If a button next
  118. to an editfield is selected this information will be displayed. The
  119. other buttons will be discussed later.
  120.  
  121.  
  122. 2.1 Refresh
  123. -----------
  124.  
  125. This value means how long MenuInfo waits until it updates its informa-
  126. tion. Values lower than 50 msec aren't allowed. Values between 200
  127. and 500 msec are fine.
  128.  
  129. The lower this value is the more time is used by MenuInfo!
  130.  
  131.  
  132. 2.2 Redraw
  133. ----------
  134.  
  135. This value means after how much periods of refreshing the information
  136. MenuInfo should redraw them.
  137.  
  138. What sense does it make? If a program has more than one menubar, Menu-
  139. Info's information will be overwritten if these menubars change. But
  140. MenuInfo has no possibility to notice that and if then the informa-
  141. tion wouldn't change you wouldn't see the information anymore.
  142.  
  143. The lower this value is the more time is used by MenuInfo!
  144.  
  145.  
  146. 2.3 Offset
  147. ----------
  148.  
  149. This value means the number of chars that the information will be
  150. shifted to the left. So you will be able to use MenuInfo together
  151. with some other tools like ShowTime, LED-Panel... which are also
  152. using the upper right corner.
  153.  
  154.  
  155. 2.4 Small font
  156. --------------
  157.  
  158. Just select it and watch the difference...
  159.  
  160.  
  161. 2.5 Use window
  162. --------------
  163.  
  164. If this button is selected MenuInfo displays the information in a
  165. small window.
  166.  
  167. "Redraw", "Offset", "VSCR-support" and "Small font" have no meaning
  168. for this window.
  169.  
  170. When MenuInfo receives a AC_CLOSE-message or you close the window
  171. MenuInfo will display the information in the upper right corner
  172. again.
  173.  
  174.  
  175. 2.6 CapsLock-LED
  176. ----------------
  177.  
  178. If this button is selected MenuInfo displays a small LED in the upper
  179. left corner of the screen. If this LED is green, CapsLock is active.
  180. Otherwise it is inactive.
  181.  
  182.  
  183. 2.7 OFLS-LED
  184. ------------
  185.  
  186. If this button is selected MenuInfo displays a small LED in the upper
  187. left corner of the screen. If this LED is red, you have opened files
  188. on your (hard)disc.
  189.  
  190. To use the OFLS-LED you have to install the freeware-program
  191. CHK_OFLS.PRG from the Kobold-distribution.
  192.  
  193.  
  194. 2.8 Top windows
  195. ---------------
  196.  
  197. If this button is selected, MenuInfo tops the window under the mouse-
  198. arrow automatically, but only if...
  199.  
  200.    ∙ the mousearrow is inside the workingarea of a window
  201.  
  202.    ∙ the mousearrow has the same position for 50 msec
  203.  
  204.    ∙ no special key (Shift, Control, Alternate) is pressed
  205.  
  206.    ∙ the current window won't be complety hidden by the new window
  207.  
  208.  
  209. 2.9 Screensaver
  210. ---------------
  211.  
  212. If this button is selected MenuInfo's screensaver is active. It's not
  213. really a screensaver that checks the keyboard or the serial inter-
  214. face(s). If you are looking for something like that, just buy Before
  215. Dawn, Twilight or something else.
  216.  
  217. No, you have to tell MenuInfo that it should save the screen. This is
  218. done by moving the mousearrow into the lower right corner of the
  219. screen.
  220.  
  221. Furthermore you can enter a value that represents the period of time,
  222. after which MenuInfo automatically starts to save the screen if you
  223. don't move the mouse. Entering a "0" means, that MenuInfo should't
  224. start savin the screen automatically.
  225.  
  226. Then MenuInfo will draw a black screen and will invert the menubar.
  227. MenuInfo will update its information while saving the screen!
  228.  
  229. After moving the mouse MenuInfo redraws the screen via
  230. form_dial(FMD_FINISH,...)).
  231.  
  232.  
  233. 2.10 Alarm
  234. ----------
  235.  
  236. Select the button and enter an alarmtime. When this time arrives Menu-
  237. Info will show you a message inside an alertbox.
  238.  
  239.  
  240. 2.11 VSCR-support
  241. -----------------
  242.  
  243. If you run a virtual resolution you have to scroll to the upper right
  244. corner to see the information displayed by MenuInfo. But if you se-
  245. lect this button and a menubar is displayed in the current part of
  246. the virtual screen, MenuInfo will also show its infornation in this
  247. upper right corner.
  248.  
  249.  
  250.  
  251. 3 Clicks onto the LEDs
  252. ======================
  253.  
  254. Click onto the LEDs and press a special key to get the follwing
  255. action:
  256.  
  257.    ∙ left mousebutton
  258.      open the configuration formular
  259.  
  260.    ∙ Alternate + left mousebutton
  261.      redraw the screen
  262.  
  263.    ∙ Shift + left mousebutton
  264.      open the fileselector
  265.  
  266.    ∙ Control + left mousebutton
  267.      copy MenuInfo's information to the clipboard
  268.  
  269.    ∙ Shift + Control + left mousebutton
  270.      send MenuInfo information via appl_tplay()
  271.  
  272.    ∙ right mousebutton
  273.      open the ASCII-table
  274.  
  275.    ∙ Shift + right mousebutton
  276.      open an extended fontselector (Calvino, FontSel)
  277.  
  278.    ∙ Control + right mousebutton
  279.      quit MenuInfo
  280.  
  281.  
  282. 3.1 Hint for users of TakeOff
  283. -----------------------------
  284.  
  285. MenuInfo places its LEDs in the upper left corner that is usually
  286. used by TakeOff. So you have simply no chance to open the popup of
  287. TakeOff here. But TakeOff offers a second chance to open its popup:
  288. just click into the upper right corner!
  289.  
  290.  
  291.  
  292. 4 Placeholders
  293. ==============
  294.  
  295. Use these placeholders inside the editfields of the configuration
  296. formular:
  297.  
  298. Some hints:
  299.  
  300.    ∙ italic ones aren't implemented yet
  301.  
  302.    ∙ absolute processes:
  303.      number of all running processes
  304.  
  305.    ∙ relative processes:
  306.      the difference between the number of processes that are nopw
  307.      running and the number of processes that where already running
  308.      when MenuInfo startet
  309.  
  310.  %a:   short weekday (Mon, Tue, ...)
  311.  
  312.  %A:   long weekday (Monday, Tuesday, ...)
  313.  
  314.  %b:   short month (Jan, Feb, ...)
  315.  
  316.  %B:   long month (January, February ...)
  317.  
  318.  %c:   date and time (17.08.1995 11:40:30)
  319.  
  320.  %d:   day of month (1-31)
  321.  
  322.  %D:   day of month (01-31)
  323.  
  324.  %f:   short fuzzy-time (10 past 12)
  325.  
  326.  %F:   long fuzzy-time (ten past twelve)
  327.  
  328.  %H:   hour (00-23)
  329.  
  330.  %I:   hour (00-12)
  331.  
  332.  %j:   day of year (1-366)
  333.  
  334.  %l:   the LF-char (a bell in the systemfont)
  335.  
  336.  %L:   the alarmtime
  337.  
  338.  %m:   month (01-12)
  339.  
  340.  %M:   minute (00-59)
  341.  
  342.  %o:   month (1-12)
  343.  
  344.  %p:   AM/PM
  345.  
  346.  %r:   time as %I:%M:%S %p (11:42:54 AM)
  347.  
  348.  %R:   time %I:%M (11:43)
  349.  
  350.  %S:   second (00-59)
  351.  
  352.  %t:   the TAB-char (a small clock in the systemfont)
  353.  
  354.  %T:   time as %H:%M:%S (11:44:10)
  355.  
  356.  %U:   time as %H:%M (11:44)
  357.  
  358.  %w:   weekday (0-6)
  359.  
  360.  %W:   /week of year (0-52)/
  361.  
  362.  %x:   local date (17.08.95)
  363.  
  364.  %X:   local time (11:44:56)
  365.  
  366.  %y:   short year (0-99)
  367.  
  368.  %Y:   long year (1995)
  369.  
  370.  %%:   the %-char
  371.  
  372.  $c:   coordinates of the complete window under the mousearrow
  373.  
  374.  $C:   coordinates of the complete top window
  375.  
  376.  $h:   handle of the window under the mousearrow
  377.  
  378.  $H:   handle of the top window
  379.  
  380.  $l:   /CPU-load/
  381.  
  382.  $m:   coordinates des mousearrows
  383.  
  384.  $o:   number of opened files
  385.  
  386.  $n:   owner of the window under the mousearrow
  387.  
  388.  $N:   owner of the top window
  389.  
  390.  $r:   sum of the biggest memoryblocks (bytes)
  391.  
  392.  $R:   sum of the biggest memoryblocks (KB)
  393.  
  394.  $s:   biggest memoryblock of ST-RAM (bytes)
  395.  
  396.  $S:   biggest memoryblock of ST-RAM (KB)
  397.  
  398.  $t:   biggest memoryblock of TT-RAM (bytes)
  399.  
  400.  $T:   biggest memoryblock of TT-RAM (KB)
  401.  
  402.  $w:   coordinates of working-area of the window under the mousearrow
  403.  
  404.  $W:   coordinates of working-area of the top window
  405.  
  406.  $$:   the $-char
  407.  
  408.  &a:   AES-Version (3.99)
  409.  
  410.  &c:   /number of free cookies/
  411.  
  412.  &C:   cookie-jar-size
  413.  
  414.  &d:   TOS-version (2.00)
  415.  
  416.  &D:   TOS-date (10.08.1993)
  417.  
  418.  &g:   GEMDOS-version (0.19)
  419.  
  420.  &k:   scancode of the latest pressed key (0x6200)
  421.  
  422.  &m:   Mag!X-version (2.00)
  423.  
  424.  &M:   Mag!X-date (26.08.1993)
  425.  
  426.  &n:   NVDI-version (3.01)
  427.  
  428.  &N:   NVDI-datum (25.11.1994)
  429.  
  430.  &o:   CHK_OFLS-version (1.03)
  431.  
  432.  &r:   sum of the number of free memoryblocks
  433.  
  434.  &s:   number of free memoryblocks of ST-RAM
  435.  
  436.  &t:   number of free memoryblocks of TT-RAM
  437.  
  438.  &w:   /WINX-version/
  439.  
  440.  &&:   the &-char
  441.  
  442.  #a:   absolute applications
  443.  
  444.  #A:   relative applications
  445.  
  446.  #c:   absolute accessories
  447.  
  448.  #C:   relative accessories
  449.  
  450.  #p:   absolute processes
  451.  
  452.  #P:   relative processes
  453.  
  454.  #y:   absolute system-processes
  455.  
  456.  #Y:   relative system-Processes
  457.  
  458.  ##:   the #-char
  459.  
  460.  
  461.  
  462. 5 ASCII-table
  463. =============
  464.  
  465. Click with the right mousebutton onto the LEDs without pressing a
  466. special key to get the ASCII-table.
  467.  
  468. After clicking a char this char will be send to the active applica-
  469. tion via appl_tplay().
  470.  
  471.  
  472.  
  473. 6 Systemrequirements
  474. ====================
  475.  
  476. MenuInfo is a GEM-application and should run with every hardware- or
  477. software-configuration.
  478.  
  479. *But:*
  480.  
  481.    ∙ MultiTOS kills MenuInfo when using memory protection. I really
  482.      don't know why. :-(
  483.  
  484.    ∙ To see the configuration-formular you have to run a resolution
  485.      with 640 pixels or more.
  486.  
  487.  
  488.  
  489.  
  490. A Legal information
  491. ===================
  492.  
  493.  
  494. A.1 Copyright
  495. -------------
  496.  
  497. MenuInfo and its documentation are copyrighted by Dirk Hagedorn
  498. Software, Germany.
  499.  
  500. MenuInfo may be given to third persons in a noncommercially way if
  501. all of the following requirements are met:
  502.  
  503.    ∙ The program has to be copied with all and unchanged files.
  504.  
  505.    ∙ It's not allowed to add files (espacially advertisement for a
  506.      BBS or a PD series). Furthermore it's not allowed to rename the
  507.      archive.
  508.  
  509.    ∙ You have to copy MenuInfo free of charge! The upload to a BBS is
  510.      only allowed if its run in a noncommercially way.
  511.  
  512.  
  513. A.2 Fairware
  514. ------------
  515.  
  516. MenuInfo ist Fairware!
  517.  
  518. If you like MenuInfo and often use, please send me an email, a post-
  519. card from your hometown or a small amount of money.
  520.  
  521. My address:
  522.  
  523.     Dirk Hagedorn
  524.     In der Esmecke 9
  525.     59846 Sundern
  526.     Germany
  527.  
  528.  
  529. A.3 Disclaimer
  530. --------------
  531.  
  532. Do everything on your own risk!
  533.  
  534. Trotz sorgfältiger Entwicklung und umfangreichen Tests kann keine
  535. Gewährleistung für die Richtigkeit des Inhalts dieser Dokumentation
  536. und die einwandfreie Funktion des Programms übernommen werden.
  537.  
  538. Dirk Hagedorn Software kann keine Haftung für irgendwelche direkten
  539. oder indirekten Schäden - einschließlich aber nicht beschränkt auf
  540. materielle oder finanzielle - übernehmen, die durch die Benutzung von
  541. MenuInfo oder dessen Untauglichkeit für einen bestimmten Zweck
  542. entstehen.
  543.  
  544.  
  545. A.4 Trademarks
  546. --------------
  547.  
  548. Innerhalb dieser Dokumentation wird auf Warenzeichen Bezug genommen,
  549. die nicht explizit als solche ausgewiesen sind. Aus dem Fehlen einer
  550. Kennzeichnung kann nicht geschlossen werden, daß ein Name frei von
  551. den Rechten Dritter ist.
  552.  
  553.  
  554.  
  555. B Future
  556. ========
  557.  
  558. MenuInfo will be updated to my own requirements. If I get some reso-
  559. nance I'll publish further versions. If I don't hear anything of
  560. anybody I will not publish further version. Why should I if I must
  561. think that nobody uses MenuInfo?
  562.  
  563.  
  564.  
  565. C The current version
  566. =====================
  567.  
  568. The current version of MenuInfo is always available in the "Öffentli-
  569. cher Programmteil" of the Maus MK2 (+49 2371 944925). A few days or
  570. weeks later the current version should also be available via FTP
  571. (ftp.uni-paderborn.de:/pub/atari/tools/util).
  572.  
  573. The archiv is named always "MINF???.LZH", "???" is replaced by the
  574. number of version.
  575.  
  576.  
  577.  
  578. D Thanks
  579. ========
  580.  
  581. Many thanks to ...
  582.  
  583.  Dirk Haun       for his wind_get-routine
  584.  
  585.  Thomas Binder   for his hints according to the topping of windows
  586.                  under SingleTOS
  587.  
  588. A special thank to the following persons who where so kind to send me
  589. some money for MenuInfo: Michael Wurm, Dieter Intas, Lothar Wagner,
  590. Wolfgang Simon, Carsten Friehe, Dirk Paulsberg, Michael Harwerth,
  591. Ulli Hahndorf, Thomas Ungricht, Dirk Kohle and to those who I've
  592. forgotten to place in this list.
  593.  
  594.  
  595.  
  596. E History
  597. =========
  598.  
  599.  
  600. E.1 Version 2.41
  601. ----------------
  602.  
  603.  New:    
  604.  
  605.  Changed: Small change in the routine that calls the xFSL.
  606.  
  607.  
  608. E.2 Version 2.40
  609. ----------------
  610.  
  611. First English version!
  612.  
  613.  
  614.  
  615.                     Dieser Text wurde erzeugt mit
  616.                                    
  617.                                  UDO
  618.                                    
  619.                               Release 4
  620.                            (Atari-Version)
  621.                                    
  622.                         Copyright (c) 1995 by
  623.                         Dirk Hagedorn Software
  624.                            In der Esmecke 9
  625.                            D-59846 Sundern
  626.                      MausNet: Dirk Hagedorn @ MK2
  627.                                    
  628.                                    
  629.         UDO ist ein Programm, welches Textdateien, die in der
  630.           eigenen UDO-Syntax erstellt wurden, in das ASCII-
  631.         ST-Guide-, LaTeX-, Rich Text-, Pure-C-Help-, 1stWord-,
  632.                HTML- und WinHelp-Format umwandeln kann.
  633.  
  634.  
  635.